/*
 * Copyright (C) 2010-2025 Structr GmbH
 *
 * This file is part of Structr <http://structr.org>.
 *
 * Structr is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Structr is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Structr.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.structr.core.function;

import org.structr.common.error.FrameworkException;
import org.structr.docs.Signature;
import org.structr.docs.Usage;
import org.structr.docs.Example;
import org.structr.docs.Parameter;
import org.structr.schema.action.ActionContext;

import java.util.Date;
import java.util.List;

public class ToDateFunction extends CoreFunction {

	@Override
	public String getName() {
		return "toDate";
	}

	@Override
	public List<Signature> getSignatures() {
		return Signature.forAllScriptingLanguages("number");
	}

	@Override
	public Object apply(final ActionContext ctx, final Object caller, final Object[] sources) throws FrameworkException {

		// if source is a number, try to convert from millis
		if (sources != null && sources.length == 1 && sources[0] != null && sources[0] instanceof Number) {

			try {
				Long timestamp = 0L;

				if (sources[0] instanceof Double) {

					timestamp = Math.round((Double) sources[0]);

				} else if (sources[0] instanceof Integer || sources[0] instanceof Long) {

					timestamp = (Long) sources[0];

				} else {
					throw new UnsupportedOperationException();
				}

				return new Date(timestamp);

			} catch (Throwable t) {
				// fail silently
			}

		} else {

			logParameterError(caller, sources, ctx.isJavaScriptContext());
			return usage(ctx.isJavaScriptContext());
		}

		return "";
	}

	@Override
	public List<Usage> getUsages() {
		return List.of(
			Usage.structrScript("Usage: ${toDate(value)}. Example: ${toDate(1473201885000)}"),
			Usage.javaScript("Usage: ${{$.toDate(value)}}. Example: ${{Structr.toDate(1473201885000)}}")
		);
	}

	@Override
	public String getShortDescription() {
		return "Converts the given number to a date.";
	}

	@Override
	public String getLongDescription() {
		return "The number is interpreted as UNIX timestamp (milliseconds from Jan. 1, 1970).";
	}

	@Override
	public List<Example> getExamples() {
		return List.of(
				Example.structrScript("${toDate(1585504800000)}"),
				Example.javaScript("${{ $.toDate(1585504800000) }}")
		);
	}

	@Override
	public List<Parameter> getParameters() {
		return List.of(
				Parameter.mandatory("number", "unix timestamp")
		);
	}

}
